/*-----------------------------------------------------------------------------
	The contents of this file are subject to the Mozilla Public License
	Version 1.1 (the "License"); you may not use this file except in
	compliance with the License.You may obtain a copy of the License at
	http://www.mozilla.org/MPL/MPL-1.1.html
	
	Software distributed under the License is distributed on an "AS IS"
	basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
	License for the specific language governing rights and limitations
	under the License.
	
	The Original Code is Fever Framework code.
	
	The Initial Developer of the Original Code is Romain Ecarnot.
	Portions created by Initial Developer are Copyright (C) 2006
	the Initial Developer. All Rights Reserved.
	
	Contributor(s):
	
	Unless required by applicable law or agreed to in writing, software
	distributed under the License is distributed on an "AS IS" BASIS,
	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	See the License for the specific language governing permissions and
	limitations under the License.
-----------------------------------------------------------------------------*/

import com.bourre.events.EventType;

import fever.app.browser.history.HistoryStatus;
import fever.app.browser.history.HistoryStrategy;
import fever.events.AbstractEvent;

/**
 * Event structure for browser history managment.
 * 
 * @author Romain Ecarnot
 */
class fever.app.browser.history.HistoryEvent extends AbstractEvent
{
	//-------------------------------------------------------------------------
	// Events definition
	//-------------------------------------------------------------------------
	
	/** Even type broadcasted when browser history change. */
	public static var onChangeEVENT : EventType = new EventType( 'onHistoryChange' );
	
	
	//-------------------------------------------------------------------------
	// Private properties
	//-------------------------------------------------------------------------
	
	private var _oStatus : HistoryStatus;
	
	
	//-------------------------------------------------------------------------
	// Public API
	//-------------------------------------------------------------------------
	
	/**
	 * Constructor.
	 * 
	 * @param type Event type triggered
	 * @param target {@link fever.app.browser.history.HistoryStrategy} which 
	 * disptach this event.
	 */ 
	public function HistoryEvent( type : EventType, target : HistoryStrategy ) 
	{
		super( type, target );
	}
	
	/**
	 * Returns history strategy used.
	 */
	public function getStrategy(  ) : HistoryStrategy
	{
		return HistoryStrategy( _oT );
	}
	
	/**
	 * Sets the history status.
	 */
	public function setStatus( status : HistoryStatus ) : Void
	{
		_oStatus = status;
	}
	
	/**
	 * Sets the history status.
	 */
	public function getStatus( ) : HistoryStatus
	{
		return _oStatus;
	}
	
	/**
	 * Returns {@code true} is state is available.
	 */
	public function hasStatus(  ) : Boolean
	{
		return _oStatus.isAvailable();
	}
	
	/**
	 * Returns clone instance.
	 */
	public function clone() : HistoryEvent
	{
		var e : HistoryEvent = new HistoryEvent( _e, _oT );
		e.setStatus( _oStatus );
		
		return e;	
	}
}